gridpack::component::MatVecInterface Class Reference

#include <base_component.hpp>

Inheritance diagram for gridpack::component::MatVecInterface:

Public Member Functions
	MatVecInterface (void)
virtual	~MatVecInterface (void)
virtual bool	matrixDiagSize (int isize, int jsize) const
virtual bool	matrixDiagValues (ComplexType *values)
virtual bool	matrixDiagValues (RealType *values)
virtual bool	matrixForwardSize (int isize, int jsize) const
virtual bool	matrixForwardValues (ComplexType *values)
virtual bool	matrixForwardValues (RealType *values)
virtual bool	matrixReverseSize (int isize, int jsize) const
virtual bool	matrixReverseValues (ComplexType *values)
virtual bool	matrixReverseValues (RealType *values)
virtual bool	vectorSize (int *isize) const
virtual bool	vectorValues (ComplexType *values)
virtual bool	vectorValues (RealType *values)
virtual void	setValues (ComplexType *values)
virtual void	setValues (RealType *values)
void	setMatVecIndex (int idx)
void	getMatVecIndex (int *idx) const
void	setMatVecIndices (int idx, int jdx)
void	getMatVecIndices (int idx, int jdx) const

Constructor & Destructor Documentation

gridpack::component::MatVecInterface::MatVecInterface ( void )

Constructor

virtual gridpack::component::MatVecInterface::~MatVecInterface ( void ) [virtual]

Destructor

Member Function Documentation

void gridpack::component::MatVecInterface::getMatVecIndex ( int * idx ) const

Get the matrix index for diagonal matrix components or vector component, based on location of component in network

Parameters:

value

of index

void gridpack::component::MatVecInterface::getMatVecIndices	(	int *	idx,
		int *	jdx
	)			const

Get the matrix indices for matrix components, * based on location of component in network

Parameters:

idx,jdx

value of indices

virtual bool gridpack::component::MatVecInterface::matrixDiagSize	(	int *	isize,
		int *	jsize
	)			const `[virtual]`

Return size of matrix block on the diagonal contributed by component

Parameters:

isize,jsize

number of rows and columns of matrix block

Returns:: false if network component does not contribute matrix element

Reimplemented in gridpack::ymatrix::YMBus, gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

virtual bool gridpack::component::MatVecInterface::matrixDiagValues ( RealType * values ) [virtual]

Reimplemented in gridpack::powerflow::PFBus.

virtual bool gridpack::component::MatVecInterface::matrixDiagValues ( ComplexType * values ) [virtual]

Return the values for a diagonal matrix block. The values are returned in row-major order.

Parameters:

values

pointer to matrix block values

Returns:: false if network component does not contribute matrix element

Reimplemented in gridpack::ymatrix::YMBus, gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

virtual bool gridpack::component::MatVecInterface::matrixForwardSize	(	int *	isize,
		int *	jsize
	)			const `[virtual]`

Return size of off-diagonal matrix block contributed by component. The values are for the forward direction.

Parameters:

isize,jsize

number of rows and columns of matrix block

Returns:: false if network component does not contribute matrix element

Reimplemented in gridpack::ymatrix::YMBranch, gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

virtual bool gridpack::component::MatVecInterface::matrixForwardValues ( RealType * values ) [virtual]

Reimplemented in gridpack::powerflow::PFBranch.

virtual bool gridpack::component::MatVecInterface::matrixForwardValues ( ComplexType * values ) [virtual]

Return the values for an off-diagonl matrix block. The values are for the forward direction and are returned in row-major order.

Parameters:

values

pointer to matrix block values

Returns:: false if network component does not contribute matrix element

Reimplemented in gridpack::ymatrix::YMBranch, gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

virtual bool gridpack::component::MatVecInterface::matrixReverseSize	(	int *	isize,
		int *	jsize
	)			const `[virtual]`

Return size of off-diagonal matrix block contributed by component. The values are for the reverse direction.

Parameters:

isize,jsize

number of rows and columns of matrix block

Returns:: false if network component does not contribute matrix element

Reimplemented in gridpack::ymatrix::YMBranch, gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

virtual bool gridpack::component::MatVecInterface::matrixReverseValues ( RealType * values ) [virtual]

Reimplemented in gridpack::powerflow::PFBranch.

virtual bool gridpack::component::MatVecInterface::matrixReverseValues ( ComplexType * values ) [virtual]

Return the values for an off-diagonl matrix block. The values are for the reverse direction and are returned in row-major order.

Parameters:

values

pointer to matrix block values

Returns:: false if network component does not contribute matrix element

Reimplemented in gridpack::ymatrix::YMBranch, gridpack::powerflow::PFBranch, and gridpack::state_estimation::SEBranch.

void gridpack::component::MatVecInterface::setMatVecIndex ( int idx )

Set the matrix index for diagonal matrix components or vector component, based on location of component in network

Parameters:

idx

value of index

void gridpack::component::MatVecInterface::setMatVecIndices	(	int	idx,
		int	jdx
	)

Set the matrix indices for matrix components, based on location of component in network

Parameters:

idx,jdx

value of indices

virtual void gridpack::component::MatVecInterface::setValues ( RealType * values ) [virtual]

Reimplemented in gridpack::powerflow::PFBus.

virtual void gridpack::component::MatVecInterface::setValues ( ComplexType * values ) [virtual]

Set values in the bus or branch component based on values in a vector or matrix

Parameters:

values

values in vector or matrix

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

virtual bool gridpack::component::MatVecInterface::vectorSize ( int * isize ) const [virtual]

Return size of vector block contributed by component

Parameters:

isize

number of vector elements

Returns:: false if network component does not contribute vector element

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

virtual bool gridpack::component::MatVecInterface::vectorValues ( RealType * values ) [virtual]

Reimplemented in gridpack::powerflow::PFBus.

virtual bool gridpack::component::MatVecInterface::vectorValues ( ComplexType * values ) [virtual]

Return the values of the vector block

Parameters:

values

pointer to vector values

Returns:: false if network component does not contribute vector element

Reimplemented in gridpack::powerflow::PFBus, and gridpack::state_estimation::SEBus.

The documentation for this class was generated from the following file:

base_component.hpp

gridpack::component::MatVecInterface Class Reference

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation